provider Replays GET /api/0/organizations/{organization_id_or_slug}/replays/{replay_id}/
@utdk/sentry /api/0/organizations/{organization_id_or_slug}/replays/{replay_id}/
Retrieve a Replay Instance
Return details on an individual replay.
organization_id_or_slug path required
The ID or slug of the organization the resource belongs to.
string
replay_id path required
The ID of the replay you'd like to retrieve. It is a 32-character hexadecimal string.
string
statsPeriod query
This defines the range of the time series, relative to now. The range is given in a `<number><unit>` format. For example `1d` for a one day range. Possible units are `m` for minutes, `h` for hours, `d` for days and `w` for weeks. You must either provide a `statsPeriod`, or a `start` and `end`.
string
start query
This defines the start of the time series range as an explicit datetime, either in UTC ISO8601 or epoch seconds. Use along with `end` instead of `statsPeriod`.
string
end query
This defines the inclusive end of the time series range as an explicit datetime, either in UTC ISO8601 or epoch seconds. Use along with `start` instead of `statsPeriod`.
string
field query
Specifies a field that should be marshaled in the output. Invalid fields will be rejected.
array
project query
The ID of the projects to filter by.
array
projectSlug query
A list of project slugs to filter your results by.
array
environment query
The environment to filter by.
string
sort query
The field to sort the output by.
string
sortBy query
The field to sort the output by.
string
orderBy query
The field to sort the output by.
string
query query
A structured query string to filter the output by.
string
per_page query
Limit the number of rows to return in the result.
integer
cursor query
The cursor parameter is used to paginate results. See [here](https://docs.sentry.io/api/pagination/) for how to use this query parameter
string

Try it

Authentication
Configure credentials for API Reference
Gateway
The gateway proxies requests and injects credentials server-side. Configure credentials above, then enter your gateway URL.

Saved automatically to browser storage.

retrieveAReplayInstance
GET/api/0/organizations/{organization_id_or_slug}/replays/{replay_id}/
Return details on an individual replay.

Parameters

required

The ID or slug of the organization the resource belongs to.

required

The ID of the replay you'd like to retrieve. It is a 32-character hexadecimal string.

This defines the range of the time series, relative to now. The range is given in a `<number><unit>` format. For example `1d` for a one day range. Possible units are `m` for minutes, `h` for hours, `d` for days and `w` for weeks. You must either provide a `statsPeriod`, or a `start` and `end`.

This defines the start of the time series range as an explicit datetime, either in UTC ISO8601 or epoch seconds. Use along with `end` instead of `statsPeriod`.

This defines the inclusive end of the time series range as an explicit datetime, either in UTC ISO8601 or epoch seconds. Use along with `start` instead of `statsPeriod`.

Specifies a field that should be marshaled in the output. Invalid fields will be rejected.

The ID of the projects to filter by.

A list of project slugs to filter your results by.

The environment to filter by.

The field to sort the output by.

The field to sort the output by.

The field to sort the output by.

A structured query string to filter the output by.

Limit the number of rows to return in the result.

The cursor parameter is used to paginate results. See [here](https://docs.sentry.io/api/pagination/) for how to use this query parameter

Enter a gateway URL above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import sentry from '@utdk/sentry';

await sentry.retrieveAReplayInstance()